<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>audio_formatter: XAudioFormatter_Config Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">audio_formatter
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('struct_x_audio_formatter___config.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">XAudioFormatter_Config Struct Reference<div class="ingroups"><a class="el" href="group__audio__formatter.html">Overview</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>This typedef contains configuration information for a audio formatter core.  
 <a href="struct_x_audio_formatter___config.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a7818697a8345ab5eae29c993d65cde29"><td class="memItemLeft" align="right" valign="top">u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_audio_formatter___config.html#a7818697a8345ab5eae29c993d65cde29">DeviceId</a></td></tr>
<tr class="memdesc:a7818697a8345ab5eae29c993d65cde29"><td class="mdescLeft">&#160;</td><td class="mdescRight">DeviceId is the unique ID of the device.  <a href="#a7818697a8345ab5eae29c993d65cde29">More...</a><br/></td></tr>
<tr class="separator:a7818697a8345ab5eae29c993d65cde29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77b37a46a977ee338a8407547403382e"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_audio_formatter___config.html#a77b37a46a977ee338a8407547403382e">BaseAddress</a></td></tr>
<tr class="memdesc:a77b37a46a977ee338a8407547403382e"><td class="mdescLeft">&#160;</td><td class="mdescRight">BaseAddress is the physical base address of the device's registers.  <a href="#a77b37a46a977ee338a8407547403382e">More...</a><br/></td></tr>
<tr class="separator:a77b37a46a977ee338a8407547403382e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00cf28fa827d42385330ca450eeeda65"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_audio_formatter___config.html#a00cf28fa827d42385330ca450eeeda65">IncludeMM2S</a></td></tr>
<tr class="memdesc:a00cf28fa827d42385330ca450eeeda65"><td class="mdescLeft">&#160;</td><td class="mdescRight">IncludeMM2S is MM2S included or not.  <a href="#a00cf28fa827d42385330ca450eeeda65">More...</a><br/></td></tr>
<tr class="separator:a00cf28fa827d42385330ca450eeeda65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab196adb9a9c8f7064c0c26d2a447313b"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_audio_formatter___config.html#ab196adb9a9c8f7064c0c26d2a447313b">IncludeS2MM</a></td></tr>
<tr class="memdesc:ab196adb9a9c8f7064c0c26d2a447313b"><td class="mdescLeft">&#160;</td><td class="mdescRight">IncludeS2MM is S2MM included or not.  <a href="#ab196adb9a9c8f7064c0c26d2a447313b">More...</a><br/></td></tr>
<tr class="separator:ab196adb9a9c8f7064c0c26d2a447313b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f7b33004190e99b88823a35bdd1ed87"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_audio_formatter___config.html#a7f7b33004190e99b88823a35bdd1ed87">MaxChannelsMM2S</a></td></tr>
<tr class="memdesc:a7f7b33004190e99b88823a35bdd1ed87"><td class="mdescLeft">&#160;</td><td class="mdescRight">MaxChannelsMM2S is the max number of channels supported in MM2S.  <a href="#a7f7b33004190e99b88823a35bdd1ed87">More...</a><br/></td></tr>
<tr class="separator:a7f7b33004190e99b88823a35bdd1ed87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8feec23f4c0e955063ca0d6819ac3de7"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_audio_formatter___config.html#a8feec23f4c0e955063ca0d6819ac3de7">MaxChannelsS2MM</a></td></tr>
<tr class="memdesc:a8feec23f4c0e955063ca0d6819ac3de7"><td class="mdescLeft">&#160;</td><td class="mdescRight">MaxChannelsS2MM is the max number of channels supported in S2MM.  <a href="#a8feec23f4c0e955063ca0d6819ac3de7">More...</a><br/></td></tr>
<tr class="separator:a8feec23f4c0e955063ca0d6819ac3de7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fbeb49a32add1b7ac84cc8354cba869"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_audio_formatter___config.html#a4fbeb49a32add1b7ac84cc8354cba869">MM2SAddrWidth</a></td></tr>
<tr class="memdesc:a4fbeb49a32add1b7ac84cc8354cba869"><td class="mdescLeft">&#160;</td><td class="mdescRight">MM2SAddrWidth is the MM2S Address Width.  <a href="#a4fbeb49a32add1b7ac84cc8354cba869">More...</a><br/></td></tr>
<tr class="separator:a4fbeb49a32add1b7ac84cc8354cba869"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a177b866f1b59cf37bc4434726ac44833"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_audio_formatter___config.html#a177b866f1b59cf37bc4434726ac44833">MM2SDataFormat</a></td></tr>
<tr class="memdesc:a177b866f1b59cf37bc4434726ac44833"><td class="mdescLeft">&#160;</td><td class="mdescRight">MM2SDataFormat is the MM2S Data format.  <a href="#a177b866f1b59cf37bc4434726ac44833">More...</a><br/></td></tr>
<tr class="separator:a177b866f1b59cf37bc4434726ac44833"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58a942ca4bc504554dd2f6e2bb07a610"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_audio_formatter___config.html#a58a942ca4bc504554dd2f6e2bb07a610">PackagingModeMM2S</a></td></tr>
<tr class="memdesc:a58a942ca4bc504554dd2f6e2bb07a610"><td class="mdescLeft">&#160;</td><td class="mdescRight">PackagingModeMM2S is the MM2S packaging mode.  <a href="#a58a942ca4bc504554dd2f6e2bb07a610">More...</a><br/></td></tr>
<tr class="separator:a58a942ca4bc504554dd2f6e2bb07a610"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a12cf0d832b79f2ca5450ad1756aed3ac"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_audio_formatter___config.html#a12cf0d832b79f2ca5450ad1756aed3ac">PackagingModeS2MM</a></td></tr>
<tr class="memdesc:a12cf0d832b79f2ca5450ad1756aed3ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">PackagingModeS2MM is the S2MM packaging mode.  <a href="#a12cf0d832b79f2ca5450ad1756aed3ac">More...</a><br/></td></tr>
<tr class="separator:a12cf0d832b79f2ca5450ad1756aed3ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75b3e9629a1b150642520ddbaae572e4"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_audio_formatter___config.html#a75b3e9629a1b150642520ddbaae572e4">S2MMAddrWidth</a></td></tr>
<tr class="memdesc:a75b3e9629a1b150642520ddbaae572e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">S2MMAddrWidth is the S2MM Address Width.  <a href="#a75b3e9629a1b150642520ddbaae572e4">More...</a><br/></td></tr>
<tr class="separator:a75b3e9629a1b150642520ddbaae572e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c70b2922caa22862a3951c48b588aca"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_audio_formatter___config.html#a4c70b2922caa22862a3951c48b588aca">S2MMDataFormat</a></td></tr>
<tr class="memdesc:a4c70b2922caa22862a3951c48b588aca"><td class="mdescLeft">&#160;</td><td class="mdescRight">S2MMDataFormat is the S2MM Data format.  <a href="#a4c70b2922caa22862a3951c48b588aca">More...</a><br/></td></tr>
<tr class="separator:a4c70b2922caa22862a3951c48b588aca"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This typedef contains configuration information for a audio formatter core. </p>
<p>Each audio formatter core should have a configuration structure associated. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a77b37a46a977ee338a8407547403382e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XAudioFormatter_Config::BaseAddress</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>BaseAddress is the physical base address of the device's registers. </p>

<p>Referenced by <a class="el" href="group__audio__formatter.html#gaef1d64562a996ebb195cf2d6ef2f6ea7">XAudioFormatter_CfgInitialize()</a>, and <a class="el" href="group__audio__formatter.html#gabec553226fe4cfd97f01d23b2c30bbad">XSdiAud_GetChStat()</a>.</p>

</div>
</div>
<a class="anchor" id="a7818697a8345ab5eae29c993d65cde29"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u16 XAudioFormatter_Config::DeviceId</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>DeviceId is the unique ID of the device. </p>

</div>
</div>
<a class="anchor" id="a00cf28fa827d42385330ca450eeeda65"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XAudioFormatter_Config::IncludeMM2S</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>IncludeMM2S is MM2S included or not. </p>

</div>
</div>
<a class="anchor" id="ab196adb9a9c8f7064c0c26d2a447313b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XAudioFormatter_Config::IncludeS2MM</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>IncludeS2MM is S2MM included or not. </p>

</div>
</div>
<a class="anchor" id="a7f7b33004190e99b88823a35bdd1ed87"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XAudioFormatter_Config::MaxChannelsMM2S</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>MaxChannelsMM2S is the max number of channels supported in MM2S. </p>

<p>Referenced by <a class="el" href="group__audio__formatter.html#ga0d2e42ac1ba8d83eca142032ad59320b">XAudioFormatterSetHwParams()</a>.</p>

</div>
</div>
<a class="anchor" id="a8feec23f4c0e955063ca0d6819ac3de7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XAudioFormatter_Config::MaxChannelsS2MM</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>MaxChannelsS2MM is the max number of channels supported in S2MM. </p>

<p>Referenced by <a class="el" href="group__audio__formatter.html#ga0d2e42ac1ba8d83eca142032ad59320b">XAudioFormatterSetHwParams()</a>.</p>

</div>
</div>
<a class="anchor" id="a4fbeb49a32add1b7ac84cc8354cba869"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XAudioFormatter_Config::MM2SAddrWidth</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>MM2SAddrWidth is the MM2S Address Width. </p>

</div>
</div>
<a class="anchor" id="a177b866f1b59cf37bc4434726ac44833"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XAudioFormatter_Config::MM2SDataFormat</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>MM2SDataFormat is the MM2S Data format. </p>

</div>
</div>
<a class="anchor" id="a58a942ca4bc504554dd2f6e2bb07a610"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XAudioFormatter_Config::PackagingModeMM2S</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>PackagingModeMM2S is the MM2S packaging mode. </p>

</div>
</div>
<a class="anchor" id="a12cf0d832b79f2ca5450ad1756aed3ac"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XAudioFormatter_Config::PackagingModeS2MM</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>PackagingModeS2MM is the S2MM packaging mode. </p>

</div>
</div>
<a class="anchor" id="a75b3e9629a1b150642520ddbaae572e4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XAudioFormatter_Config::S2MMAddrWidth</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>S2MMAddrWidth is the S2MM Address Width. </p>

</div>
</div>
<a class="anchor" id="a4c70b2922caa22862a3951c48b588aca"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XAudioFormatter_Config::S2MMDataFormat</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>S2MMDataFormat is the S2MM Data format. </p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
